auth: dedicated page for health checks and re-auth#365
Conversation
Consolidates scattered FAQ entries on health check cadence, can_reauth eligibility, manual re-auth, login failure codes, and debugging into a single Health Checks & Re-Auth page. FAQ entries now defer to the new page with a short summary and link. Overview links to it from the Session monitoring bullet.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Risk assessment: Very Low
This PR only changes documentation content and Mintlify navigation: it adds auth/health-checks.mdx, moves existing FAQ detail into that dedicated page, updates one overview link, and adds the page to docs.json. I found no production code, infrastructure, auth logic, permissions, or prompt/model-instruction changes in the diff. No CODEOWNERS file was present, and the PR had no existing approvals in the metadata I checked.
Sent by Cursor Automation: Assign PR reviewers
- Rename page to Connection Lifecycle (auth/connection-lifecycle.mdx) to match the page's scope beyond just health checks - Fix Start-Up minimum interval (15 min -> 20 min) to match StartupMinHealthCheckIntervalSeconds in the API - Move nav position to right after Configuration, before Credentials - Slim Debugging section to the per-login override; link out to Connection Configuration for the connection-wide record_session flag - Add a pointer from overview's How It Works to the lifecycle page so the integration loop and runtime loop don't compete - Update cross-links in faq + overview to the new path
|
overall i like the direction — same restructure pattern as #361 (pull scattered FAQ content into a stable URL, leave one-liners + links in the FAQ). a few things to consider before merge: bug to fix — Start-Up minimum is wrongThe cadence table says Start-Up minimum is 15 minutes. The real value in const StartupMinHealthCheckIntervalSeconds = 1200 // 20 minThe original FAQ had the same wrong number — it got carried forward. Worth fixing in this PR. reframe as "Connection Lifecycle""Health Checks" is narrower than what the page covers — health-check cadence is one of ~six sections (lifecycle, cadence,
Reading order: overview → pick integration → configure → understand how it runs/breaks. nav placementCurrently placed between Profiles and FAQ. I'd put it right after sequencing with #361The page links to mild duplication — debugging sectionThe Debugging a flaky connection section covers minor — overlap with overview's "How It Works"
verified
|
There was a problem hiding this comment.
Risk assessment: Very Low
The current diff only changes documentation and Mintlify navigation: it adds auth/connection-lifecycle.mdx, shortens auth/faq.mdx by linking to the dedicated page, updates auth/overview.mdx links/copy, and adds the new page to docs.json. I found no production code, infrastructure, auth implementation, permissions, or prompt/model-instruction changes.
The PR is already approved, so I’m leaving the existing approval in place and not re-approving.
Sent by Cursor Automation: Assign PR reviewers
2 participants
Summary
There's no single home for managed auth connection health checks / re-auth troubleshooting today — the content is scattered across the FAQ and lightly touched in Configuration. This adds a dedicated Health Checks & Re-Auth page under Auth.
The new page consolidates:
NEEDS_AUTH)health_check_intervalcan_reautheligibility rules and what blocks auto-reauth.login()credentials_invalid,bot_detected,captcha_blocked,unsupported_auth_method) and how to recover from eachrecord_sessionFAQ entries that were the de-facto reference for this material are trimmed to a one-liner that links into the new page, so the FAQ stays focused on Q&A and the deep content has a stable URL. Overview's "Session monitoring" bullet also links to the new page.
Test plan
#when-a-login-fails,#triggering-re-auth-manually,#debugging-a-flaky-connection)/auth/configuration#custom-proxy,/auth/credentials,/integrations/1password,/browsers/replays,/browsers/bot-detection/overviewall resolve